home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 476-500 / disk_500 / wiconify / wutilities.lzh / wIconifyWindow / wIconifyWindow.doc < prev    next >
Text File  |  1991-04-19  |  4KB  |  86 lines
  1. OVERVIEW:
  2.  
  3. wIconifyWindow is a companion program to wIconify.  It allows you to to
  4. request (from the CLI) that a window be iconified, and also allows you to
  5. specify the icon's new position and some flags that control its functions
  6. within wIconify.  It is intended mainly for use within the Startup-Sequence
  7. and in EXECUTE scripts.
  8.  
  9.  
  10. HOW TO USE WICONIFYWINDOW:
  11.  
  12. To use wIconifyWindow, you must have wIconify running.  To iconify a window,
  13. simply type
  14.  
  15.     1> wIconifyWindow [window]
  16.  
  17. where [window] is the name of the window to iconify.  If the window is not
  18. already iconified, and if it is able to be iconified, it will be replaced by
  19. an icon toward the bottom on the wIconify window.  If the window is already
  20. iconified, it will be restored and the icon removed.
  21.  
  22. You can also specify a screen name if the window is not on the active
  23. screen.  The following example would iconify the AmigaDos window on the
  24. workbench screen:
  25.  
  26.     1> wIconifyWindow AmigaDos Workbench
  27.  
  28. If the window or screen name contains a space, enclose it in quotation
  29. marks, as in the example below:
  30.  
  31.     1> wIconifyWindow "Calc v3.0" "Test Screen"
  32.  
  33. If you do not give a screen name, the currently active screen is assumed. 
  34. If you do not give a window name, the currently active window is assumed.
  35.  
  36. To specify the position of the icon, add 'AT x,y' to the commmand, where x
  37. and y are the position (in pixels) from the upper left-hand corner of the
  38. wIconify window where you want the icon to appear.  wIconify will place the
  39. icon as close to this position as possible, without interfering with other
  40. icons.
  41.  
  42.     1> wIconifyWindow AmigaShell AT 50,100
  43.  
  44. would iconify the AmigaShell window and place the icon at 50 pixels from the
  45. left of the window and 100 pixels down from the top of the wIconify window.
  46. If you do not specify a position, the first available position will be used.
  47.  
  48. You must not put a space around the comma when you specify a position.  Thus
  49. '10 ,20' '45, 110' and '55 , 75' are all illegal position, while '300,50' is
  50. acceptable.
  51.  
  52. You can also supply a number of flags that alter the way wIconify treats the 
  53. window's icon.  These include:
  54.  
  55.     NOSAVEPOS       Don't save the icons possition after it is openned
  56.     NOMOVE          Don't allow the icon to be dragged from its current position
  57.     NOORGANIZE      ORGANIZE and CLEANUP will not affect this icon
  58.     LOCKED          Don't allow the icon's position to change at all
  59.     NOCLOSE         Don't allow the CLOSE menu or left-right click to close
  60.                     this icon's window
  61.     NOMULTISELECT   Don't allow other icons to be selected together with
  62.                     this one
  63.     CHANGEREFRESH   If the window is SMART_REFRESH change it to SIMPLE_REFRESH
  64.                     whenever it is iconified.  WARNING: this is somewhat 
  65.                     dangerous, and may result in the update status of the
  66.                     screen becoming confused.  See the wIconify documentation
  67.                     for more information.
  68.  
  69. You can plas a minus sign (-) in front of any of these flags; this will case
  70. the given attribute to be removed from the icon.  For example, -NOMOVE
  71. would remove the NOMOVE attribute, hence the icon would become moveable.
  72.  
  73. If you supply any of these flags, they will remain in effect until you close
  74. the window, or until you issue another wIconifyWindow command for the given
  75. window that changes the settings of the flags.  The default is to change none
  76. of these flags.
  77.  
  78.  
  79. AUTHOR:
  80.  
  81. Davide P. Cervone
  82. Mathematics Department
  83. Brown University
  84. Providence, Rhode Island 02912
  85. ST402523@BROWNVM
  86.